Class PTPClockImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.PTPClockImpl
All Implemented Interfaces:
IPCObject, PTPClock

public class PTPClockImpl extends IPCObjectImpl implements PTPClock
Information provided by the PKI file:

    \class PTPClock
    \brief              This file holds CPTPClock class declaration
    \example network().getDevice("Switch0").getProcess("CPTPProcess").getClock();
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setMode

      public void setMode(PTPMode mode)
      Information provided by the PKI file:
      
          \brief Sets the mode.
          
          \param mode,        the type of timer.
          Timer types:        eE2etransparent = 0,
          eBoundary = 1,
          eForward = 2
          
              
      Specified by:
      setMode in interface PTPClock
      Parameters:
      mode - Takes in a parameter of mode
    • getMode

      public PTPMode getMode()
      Information provided by the PKI file:
      
          \brief Returns the mode.
          
          \return PTPMode, the modes.
          Mode types: eE2etransparent = 0,
          eBoundary = 1,
          eForward = 2
          
              
      Specified by:
      getMode in interface PTPClock
      Returns:
      PTPMode Returns a PTPMode
    • getModeStr

      public String getModeStr()
      Information provided by the PKI file:
      
          \brief Returns the mode as a string.
          
          \return string,     Mode strings:   "e2etransparent",
          "boundary",
          "forward"
          
              
      Specified by:
      getModeStr in interface PTPClock
      Returns:
      String Returns a String
    • getNumOfPorts

      public int getNumOfPorts()
      Information provided by the PKI file:
      
          \brief Returns the number of ports.
          
          \return int, the number of ports.
          
              
      Specified by:
      getNumOfPorts in interface PTPClock
      Returns:
      int Returns a int
    • setProfile

      public void setProfile(PTPProfile profile)
      Information provided by the PKI file:
      
          \brief Sets the profile type.
          
          \param profile,     the type of timer.
          Timer types:        eDefault = 0,
          ePower = 1
          
              
      Specified by:
      setProfile in interface PTPClock
      Parameters:
      profile - Takes in a parameter of profile
    • getProfile

      public PTPProfile getProfile()
      Information provided by the PKI file:
      
          \brief Gets the profile type.
          
          \return  PTPProfile,        the profile type.
          Timer types:        eDefault = 0,
          ePower = 1
          
              
      Specified by:
      getProfile in interface PTPClock
      Returns:
      PTPProfile Returns a PTPProfile
    • getProfileStr

      public String getProfileStr()
      Information provided by the PKI file:
      
          \brief Returns the profile as a string.
          
          \return string,     profile strings:        "Default",
          "Power"
          
              
      Specified by:
      getProfileStr in interface PTPClock
      Returns:
      String Returns a String
    • setDelayMechanism

      public void setDelayMechanism(DelayMechanism delay)
      Information provided by the PKI file:
      
          \brief Sets the delay mechanism type.
          
          \param delay,       the type of delay.
          Timer types:        eEnd2End = 0,
          ePeer2Peer = 1
          
              
      Specified by:
      setDelayMechanism in interface PTPClock
      Parameters:
      delay - Takes in a parameter of delay
    • getDelayMechanism

      public int getDelayMechanism()
      Information provided by the PKI file:
      
          \brief Gets the profile type.
          
          \return  int, the profile type.
          Timer types:        eDefault = 0,
          ePower = 1
          
              
      Specified by:
      getDelayMechanism in interface PTPClock
      Returns:
      int Returns a int
    • getDelayMechanismStr

      public String getDelayMechanismStr()
      Information provided by the PKI file:
      
          \brief Returns the delay mechanisim as a string.
          
          \return string,     profile strings:        "End to End",
          "Peer to Peer"
          
              
      Specified by:
      getDelayMechanismStr in interface PTPClock
      Returns:
      String Returns a String
    • setPriority1

      public void setPriority1(int val)
      Information provided by the PKI file:
      
          \brief Sets priority 1 to the given value.
          
          \param val, value to use.
          
              
      Specified by:
      setPriority1 in interface PTPClock
      Parameters:
      val - Takes in a parameter of val
    • setPriority2

      public void setPriority2(int val)
      Information provided by the PKI file:
      
          \brief Sets priority 2 to the given value.
          
          \param val, value to use.
          
              
      Specified by:
      setPriority2 in interface PTPClock
      Parameters:
      val - Takes in a parameter of val
    • setPtpTime

      public void setPtpTime(String time)
      Information provided by the PKI file:
      
          \brief Sets ptp time to the given value.
          
          \param time, time to use.
          
              
      Specified by:
      setPtpTime in interface PTPClock
      Parameters:
      time - Takes in a parameter of time
    • clearConfig

      public void clearConfig()
      Information provided by the PKI file:
      
          \brief Clears the config.
          
              
      Specified by:
      clearConfig in interface PTPClock
    • init

      public void init()
      Information provided by the PKI file:
      
          \brief Runs the init setup.
          
              
      Specified by:
      init in interface PTPClock